docs: document recipient type for agent HITL actions#900
Merged
Conversation
The HITL docs covered only the `assignee` string and omitted the `recipient` (TaskRecipient) field that ships on CreateTask / CreateEscalation / WaitTask / WaitEscalation. Document the structured recipient model, the TaskRecipientType values (EMAIL, USER_ID, GROUP_NAME, GROUP_ID), the import path, and that `recipient` takes precedence over `assignee`. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the Human-in-the-Loop guide to document the structured recipient: Optional[TaskRecipient] assignment mechanism for agent HITL interrupt models, clarifying how to target users/groups and how it interacts with the legacy assignee field.
Changes:
- Documented
recipientonCreateTask,WaitTask,CreateEscalation, andWaitEscalation, including precedence overassignee. - Added a dedicated “Assigning the action to a user or group” section describing
TaskRecipient/TaskRecipientType. - Added runnable examples assigning actions to a user (email) and to a group (name).
|
dushyant-uipath
approved these changes
Jun 10, 2026
dianagrecu-uipath
approved these changes
Jun 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed?
The Human-in-the-Loop docs (
docs/human_in_the_loop.md) only documented the legacyassigneestring and never mentioned the structuredrecipientfield, even though it has shipped on the agent HITL interrupt models sinceuipathPRs #1161 and #1274. A doc edit made after those PRs (#789) still missed it.This corrects that mismatch:
recipient(Optional[TaskRecipient]) attribute onCreateTask,CreateEscalation,WaitTask, andWaitEscalation.TaskRecipientmodel (type,value,display_name), its import path (uipath.platform.action_center.tasks), and theTaskRecipientTypevalues:EMAIL,USER_ID,GROUP_NAME,GROUP_ID.recipienttakes precedence overassigneewhen both are set.Scope is agent HITL only — guardrails escalation docs are untouched.
How has this been tested?
Docs-only change (no code). Every documented fact was verified against the installed
uipathSDK (v2.10.79):recipient: TaskRecipient | Noneexists onCreateTask/CreateEscalation/WaitTask/WaitEscalation(interrupt_models.py).TaskRecipient(type=..., value=...)constructs fromuipath.platform.action_center.tasks; enum values confirmed (UserId/GroupId/UserEmail/GroupName)._tasks_service.py(_assign_task_spec:if task_recipient: ... elif assignee:).Are there any breaking changes?